<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: PDFPageProxy</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: PDFPageProxy</h1>

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>
            <span class="ancestors"><a href="module-pdfjsLib.html">pdfjsLib</a>~</span>PDFPageProxy<span class="signature">()</span><span class="type-signature"></span></h2>
        
            <div class="class-description">Proxy to a `PDFPage` in the worker thread.</div>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    
    <h2>Constructor</h2>
    

    
    <h4 class="name" id="PDFPageProxy"><span class="type-signature"></span>new PDFPageProxy<span class="signature">()</span><span class="type-signature"></span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1219">line 1219</a>
    </li></ul></dd>
    

    

    

    
</dl>




















    
    </div>

    

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id="commonObjs"><span class="type-signature"></span>commonObjs<span class="type-signature"> :PDFObjects</span></h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">PDFObjects</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1228">line 1228</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="pageNumber"><span class="type-signature"></span>pageNumber<span class="type-signature"> :number</span></h4>




<div class="description">
    Page number of the page. First page is 1.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1243">line 1243</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="ref"><span class="type-signature"></span>ref<span class="type-signature"> :RefProxy|null</span></h4>




<div class="description">
    The reference that points to this page.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">RefProxy</span>
|

<span class="param-type">null</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1257">line 1257</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="rotate"><span class="type-signature"></span>rotate<span class="type-signature"> :number</span></h4>




<div class="description">
    The number of degrees the page is rotated clockwise.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1250">line 1250</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="stats"><span class="type-signature"></span>stats<span class="type-signature"> :Object</span></h4>




<div class="description">
    Returns page stats, if enabled; returns `null` otherwise.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1850">line 1850</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="userUnit"><span class="type-signature"></span>userUnit<span class="type-signature"> :number</span></h4>




<div class="description">
    The default size of units in 1/72nds of an inch.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1264">line 1264</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="view"><span class="type-signature"></span>view<span class="type-signature"> :Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>></span></h4>




<div class="description">
    An array of the visible portion of the PDF page in  user space units [x1, y1, x2, y2].
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1272">line 1272</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="cleanup"><span class="type-signature"></span>cleanup<span class="signature">(resetStats<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

    



<div class="description">
    Cleans up resources allocated by the page.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>resetStats</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">Reset page stats, if enabled.
  The default value is `false`.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1649">line 1649</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Indicates if clean-up was successfully run.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getAnnotations"><span class="type-signature"></span>getAnnotations<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>>>}</span></h4>
    

    











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>params</code></td>
            

            <td class="type">
            
                
<span class="param-type">GetAnnotationsParameters</span>


            
            </td>

            

            

            <td class="description last">Annotation parameters.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1303">line 1303</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with an
  {Array} of the annotation objects.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getJSActions"><span class="type-signature"></span>getJSActions<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Object:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1321">line 1321</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with an
  {Object} with JS actions.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;Object:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getOperatorList"><span class="type-signature"></span>getOperatorList<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;PDFOperatorList:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>params</code></td>
            

            <td class="type">
            
                
<span class="param-type">GetOperatorListParameters</span>


            
            </td>

            

            

            <td class="description last">Page getOperatorList
  parameters.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1482">line 1482</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise resolved with an
  PDFOperatorList object that represents the page's operator list.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;PDFOperatorList:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getStructTree"><span class="type-signature"></span>getStructTree<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;StructTreeNode:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1600">line 1600</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with a
  StructTreeNode object that represents the page's structure tree,
  or `null` when no structure tree is present for the current page.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;StructTreeNode:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getTextContent"><span class="type-signature"></span>getTextContent<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;TextContent:<a href="module-pdfjsLib-PDFObjects.html"></a>>}</span></h4>
    

    



<div class="description">
    NOTE: All occurrences of whitespace will be replaced by
standard spaces (0x20).
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>params</code></td>
            

            <td class="type">
            
                
<span class="param-type">getTextContentParameters</span>


            
            </td>

            

            

            <td class="description last">getTextContent parameters.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1563">line 1563</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with a
  TextContent object that represents the page's text content.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;TextContent:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getViewport"><span class="type-signature"></span>getViewport<span class="signature">(params)</span><span class="type-signature"> &rarr; {PageViewport}</span></h4>
    

    











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>params</code></td>
            

            <td class="type">
            
                
<span class="param-type">GetViewportParameters</span>


            
            </td>

            

            

            <td class="description last">Viewport parameters.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1281">line 1281</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Contains 'width' and 'height' properties
  along with transforms required for rendering.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">PageViewport</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getXfa"><span class="type-signature">(async) </span>getXfa<span class="signature">()</span><span class="type-signature"> &rarr; {Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)>}</span></h4>
    

    















<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1333">line 1333</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    A promise that is resolved with
  an {Object} with a fake DOM object (a tree structure where elements
  are {Object} with a name, attributes (class, style, ...), value and
  children, very similar to a HTML DOM tree), or `null` if no XFA exists.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(Object:<a href="module-pdfjsLib-PDFObjects.html"></a>|null:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="render"><span class="type-signature"></span>render<span class="signature">(params)</span><span class="type-signature"> &rarr; {RenderTask}</span></h4>
    

    



<div class="description">
    Begins the process of rendering a page to the desired context.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>params</code></td>
            

            <td class="type">
            
                
<span class="param-type">RenderParameters</span>


            
            </td>

            

            

            <td class="description last">Page render parameters.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1344">line 1344</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    An object that contains a promise that is
  resolved when the page finishes rendering.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">RenderTask</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="streamTextContent"><span class="type-signature"></span>streamTextContent<span class="signature">(params)</span><span class="type-signature"> &rarr; {ReadableStream}</span></h4>
    

    



<div class="description">
    NOTE: All occurrences of whitespace will be replaced by
standard spaces (0x20).
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>params</code></td>
            

            <td class="type">
            
                
<span class="param-type">getTextContentParameters</span>


            
            </td>

            

            

            <td class="description last">getTextContent parameters.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1533">line 1533</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        
<div class="param-desc">
    Stream for reading text content chunks.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">ReadableStream</span>


    </dd>
</dl>

    





        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pdfjsLib.html">pdfjsLib</a></li></ul><h3>Classes</h3><ul><li><a href="module-pdfjsLib-PDFDataRangeTransport.html">PDFDataRangeTransport</a></li><li><a href="module-pdfjsLib-PDFDocumentLoadingTask.html">PDFDocumentLoadingTask</a></li><li><a href="module-pdfjsLib-PDFDocumentProxy.html">PDFDocumentProxy</a></li><li><a href="module-pdfjsLib-PDFObjects.html">PDFObjects</a></li><li><a href="module-pdfjsLib-PDFPageProxy.html">PDFPageProxy</a></li><li><a href="module-pdfjsLib-PDFWorker.html">PDFWorker</a></li><li><a href="module-pdfjsLib-RenderTask.html">RenderTask</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Sep 07 2022 09:51:16 GMT+0000 (Coordinated Universal Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>